home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / hplip / base / utils.py < prev    next >
Text File  |  2009-10-09  |  50KB  |  1,636 lines
  1. # -*- coding: utf-8 -*-
  2. #
  3. # (c) Copyright 2001-2009 Hewlett-Packard Development Company, L.P.
  4. #
  5. # This program is free software; you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation; either version 2 of the License, or
  8. # (at your option) any later version.
  9. #
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program; if not, write to the Free Software
  17. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18. #
  19. # Author: Don Welch
  20. #
  21. # Thanks to Henrique M. Holschuh <hmh@debian.org> for various security patches
  22. #
  23.  
  24. from __future__ import generators
  25.  
  26. # Std Lib
  27. import sys
  28. import os
  29. import fnmatch
  30. import tempfile
  31. import socket
  32. import struct
  33. import select
  34. import time
  35. import fcntl
  36. import errno
  37. import stat
  38. import string
  39. import commands # TODO: Replace with subprocess (commands is deprecated in Python 3.0)
  40. import cStringIO
  41. import re
  42. import xml.parsers.expat as expat
  43. import getpass
  44. import locale
  45. import htmlentitydefs
  46.  
  47. try:
  48.     import platform
  49.     platform_avail = True
  50. except ImportError:
  51.     platform_avail = False
  52.  
  53. # Local
  54. from g import *
  55. from codes import *
  56. import pexpect
  57.  
  58. BIG_ENDIAN = 0
  59. LITTLE_ENDIAN = 1
  60.  
  61.  
  62.  
  63. def lock(f):
  64.     log.debug("Locking: %s" % f.name)
  65.     try:
  66.         fcntl.flock(f.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB)
  67.         return True
  68.     except (IOError, OSError):
  69.         log.debug("Failed to unlock %s." % f.name)
  70.         return False
  71.  
  72.  
  73. def unlock(f):
  74.     if f is not None:
  75.         log.debug("Unlocking: %s" % f.name)
  76.         try:
  77.             fcntl.flock(f.fileno(), fcntl.LOCK_UN)
  78.             os.remove(f.name)
  79.         except (IOError, OSError):
  80.             pass
  81.  
  82.  
  83. def lock_app(application, suppress_error=False):
  84.     dir = prop.user_dir
  85.     if os.geteuid() == 0:
  86.         dir = '/var'
  87.  
  88.     elif not os.path.exists(dir):
  89.         os.makedirs(dir)
  90.  
  91.     lock_file = os.path.join(dir, '.'.join([application, 'lock']))
  92.     try:
  93.         lock_file_f = open(lock_file, "w")
  94.     except IOError:
  95.         if not suppress_error:
  96.             log.error("Unable to open %s lock file." % lock_file)
  97.         return False, None
  98.  
  99.     #log.debug("Locking file: %s" % lock_file)
  100.  
  101.     if not lock(lock_file_f):
  102.         if not suppress_error:
  103.             log.error("Unable to lock %s. Is %s already running?" % (lock_file, application))
  104.         return False, None
  105.  
  106.     return True, lock_file_f
  107.  
  108.  
  109. #xml_basename_pat = re.compile(r"""HPLIP-(\d*)_(\d*)_(\d*).xml""", re.IGNORECASE)
  110.  
  111.  
  112. def Translator(frm='', to='', delete='', keep=None):
  113.     allchars = string.maketrans('','')
  114.  
  115.     if len(to) == 1:
  116.         to = to * len(frm)
  117.     trans = string.maketrans(frm, to)
  118.  
  119.     if keep is not None:
  120.         delete = allchars.translate(allchars, keep.translate(allchars, delete))
  121.  
  122.     def callable(s):
  123.         return s.translate(trans, delete)
  124.  
  125.     return callable
  126.  
  127.  
  128. def to_bool_str(s, default='0'):
  129.     """ Convert an arbitrary 0/1/T/F/Y/N string to a normalized string 0/1."""
  130.     if isinstance(s, str) and s:
  131.         if s[0].lower() in ['1', 't', 'y']:
  132.             return u'1'
  133.         elif s[0].lower() in ['0', 'f', 'n']:
  134.             return u'0'
  135.  
  136.     return default
  137.  
  138. def to_bool(s, default=False):
  139.     """ Convert an arbitrary 0/1/T/F/Y/N string to a boolean True/False value."""
  140.     if isinstance(s, str) and s:
  141.         if s[0].lower() in ['1', 't', 'y']:
  142.             return True
  143.         elif s[0].lower() in ['0', 'f', 'n']:
  144.             return False
  145.     elif isinstance(s, bool):
  146.         return s
  147.  
  148.     return default
  149.  
  150.  
  151. def walkFiles(root, recurse=True, abs_paths=False, return_folders=False, pattern='*', path=None):
  152.     if path is None:
  153.         path = root
  154.  
  155.     try:
  156.         names = os.listdir(root)
  157.     except os.error:
  158.         raise StopIteration
  159.  
  160.     pattern = pattern or '*'
  161.     pat_list = pattern.split(';')
  162.  
  163.     for name in names:
  164.         fullname = os.path.normpath(os.path.join(root, name))
  165.  
  166.         for pat in pat_list:
  167.             if fnmatch.fnmatch(name, pat):
  168.                 if return_folders or not os.path.isdir(fullname):
  169.                     if abs_paths:
  170.                         yield fullname
  171.                     else:
  172.                         try:
  173.                             yield os.path.basename(fullname)
  174.                         except ValueError:
  175.                             yield fullname
  176.  
  177.         #if os.path.islink(fullname):
  178.         #    fullname = os.path.realpath(os.readlink(fullname))
  179.  
  180.         if recurse and os.path.isdir(fullname): # or os.path.islink(fullname):
  181.             for f in walkFiles(fullname, recurse, abs_paths, return_folders, pattern, path):
  182.                 yield f
  183.  
  184.  
  185. def is_path_writable(path):
  186.     if os.path.exists(path):
  187.         s = os.stat(path)
  188.         mode = s[stat.ST_MODE] & 0777
  189.  
  190.         if mode & 02:
  191.             return True
  192.         elif s[stat.ST_GID] == os.getgid() and mode & 020:
  193.             return True
  194.         elif s[stat.ST_UID] == os.getuid() and mode & 0200:
  195.             return True
  196.  
  197.     return False
  198.  
  199.  
  200. # Provides the TextFormatter class for formatting text into columns.
  201. # Original Author: Hamish B Lawson, 1999
  202. # Modified by: Don Welch, 2003
  203. class TextFormatter:
  204.  
  205.     LEFT  = 0
  206.     CENTER = 1
  207.     RIGHT  = 2
  208.  
  209.     def __init__(self, colspeclist):
  210.         self.columns = []
  211.         for colspec in colspeclist:
  212.             self.columns.append(Column(**colspec))
  213.  
  214.     def compose(self, textlist, add_newline=False):
  215.         numlines = 0
  216.         textlist = list(textlist)
  217.         if len(textlist) != len(self.columns):
  218.             log.error("Formatter: Number of text items does not match columns")
  219.             return
  220.         for text, column in map(None, textlist, self.columns):
  221.             column.wrap(text)
  222.             numlines = max(numlines, len(column.lines))
  223.         complines = [''] * numlines
  224.         for ln in range(numlines):
  225.             for column in self.columns:
  226.                 complines[ln] = complines[ln] + column.getline(ln)
  227.         if add_newline:
  228.             return '\n'.join(complines) + '\n'
  229.         else:
  230.             return '\n'.join(complines)
  231.  
  232. class Column:
  233.  
  234.     def __init__(self, width=78, alignment=TextFormatter.LEFT, margin=0):
  235.         self.width = width
  236.         self.alignment = alignment
  237.         self.margin = margin
  238.         self.lines = []
  239.  
  240.     def align(self, line):
  241.         if self.alignment == TextFormatter.CENTER:
  242.             return line.center(self.width)
  243.         elif self.alignment == TextFormatter.RIGHT:
  244.             return line.rjust(self.width)
  245.         else:
  246.             return line.ljust(self.width)
  247.  
  248.     def wrap(self, text):
  249.         self.lines = []
  250.         words = []
  251.         for word in text.split():
  252.             if word <= self.width:
  253.                 words.append(word)
  254.             else:
  255.                 for i in range(0, len(word), self.width):
  256.                     words.append(word[i:i+self.width])
  257.         if not len(words): return
  258.         current = words.pop(0)
  259.         for word in words:
  260.             increment = 1 + len(word)
  261.             if len(current) + increment > self.width:
  262.                 self.lines.append(self.align(current))
  263.                 current = word
  264.             else:
  265.                 current = current + ' ' + word
  266.         self.lines.append(self.align(current))
  267.  
  268.     def getline(self, index):
  269.         if index < len(self.lines):
  270.             return ' '*self.margin + self.lines[index]
  271.         else:
  272.             return ' ' * (self.margin + self.width)
  273.  
  274.  
  275.  
  276. class Stack:
  277.     def __init__(self):
  278.         self.stack = []
  279.  
  280.     def pop(self):
  281.         return self.stack.pop()
  282.  
  283.     def push(self, value):
  284.         self.stack.append(value)
  285.  
  286.     def as_list(self):
  287.         return self.stack
  288.  
  289.     def clear(self):
  290.         self.stack = []
  291.  
  292.     def __len__(self):
  293.         return len(self.stack)
  294.  
  295.  
  296.  
  297. class Queue(Stack):
  298.     def __init__(self):
  299.         Stack.__init__(self)
  300.  
  301.     def get(self):
  302.         return self.stack.pop(0)
  303.  
  304.     def put(self, value):
  305.         Stack.push(self, value)
  306.  
  307.  
  308.  
  309. # RingBuffer class
  310. # Source: Python Cookbook 1st Ed., sec. 5.18, pg. 201
  311. # Credit: Sebastien Keim
  312. # License: Modified BSD
  313. class RingBuffer:
  314.     def __init__(self, size_max=50):
  315.         self.max = size_max
  316.         self.data = []
  317.  
  318.     def append(self,x):
  319.         """append an element at the end of the buffer"""
  320.         self.data.append(x)
  321.  
  322.         if len(self.data) == self.max:
  323.             self.cur = 0
  324.             self.__class__ = RingBufferFull
  325.  
  326.     def replace(self, x):
  327.         """replace the last element instead off appending"""
  328.         self.data[-1] = x
  329.  
  330.     def get(self):
  331.         """ return a list of elements from the oldest to the newest"""
  332.         return self.data
  333.  
  334.  
  335. class RingBufferFull:
  336.     def __init__(self, n):
  337.         #raise "you should use RingBuffer"
  338.         pass
  339.  
  340.     def append(self, x):
  341.         self.data[self.cur] = x
  342.         self.cur = (self.cur+1) % self.max
  343.  
  344.     def replace(self, x):
  345.         # back up 1 position to previous location
  346.         self.cur = (self.cur-1) % self.max
  347.         self.data[self.cur] = x
  348.         # setup for next item
  349.         self.cur = (self.cur+1) % self.max
  350.  
  351.     def get(self):
  352.         return self.data[self.cur:] + self.data[:self.cur]
  353.  
  354.  
  355.  
  356. def sort_dict_by_value(d):
  357.     """ Returns the keys of dictionary d sorted by their values """
  358.     items=d.items()
  359.     backitems=[[v[1],v[0]] for v in items]
  360.     backitems.sort()
  361.     return [backitems[i][1] for i in range(0, len(backitems))]
  362.  
  363.  
  364. def commafy(val):
  365.     return unicode(locale.format("%d", val, grouping=True))
  366.  
  367.  
  368. def format_bytes(s, show_bytes=False):
  369.     if s < 1024:
  370.         return ''.join([commafy(s), ' B'])
  371.     elif 1024 < s < 1048576:
  372.         if show_bytes:
  373.             return ''.join([unicode(round(s/1024.0, 1)) , u' KB (',  commafy(s), ')'])
  374.         else:
  375.             return ''.join([unicode(round(s/1024.0, 1)) , u' KB'])
  376.     elif 1048576 < s < 1073741824:
  377.         if show_bytes:
  378.             return ''.join([unicode(round(s/1048576.0, 1)), u' MB (',  commafy(s), ')'])
  379.         else:
  380.             return ''.join([unicode(round(s/1048576.0, 1)), u' MB'])
  381.     else:
  382.         if show_bytes:
  383.             return ''.join([unicode(round(s/1073741824.0, 1)), u' GB (',  commafy(s), ')'])
  384.         else:
  385.             return ''.join([unicode(round(s/1073741824.0, 1)), u' GB'])
  386.  
  387.  
  388.  
  389. try:
  390.     make_temp_file = tempfile.mkstemp # 2.3+
  391. except AttributeError:
  392.     def make_temp_file(suffix='', prefix='', dir='', text=False): # pre-2.3
  393.         path = tempfile.mktemp(suffix)
  394.         fd = os.open(path, os.O_RDWR|os.O_CREAT|os.O_EXCL, 0700)
  395.         return ( os.fdopen( fd, 'w+b' ), path )
  396.  
  397.  
  398.  
  399. def which(command, return_full_path=False):
  400.     path = os.getenv('PATH').split(':')
  401.  
  402.     # Add these paths for Fedora
  403.     path.append('/sbin')
  404.     path.append('/usr/sbin')
  405.     path.append('/usr/local/sbin')
  406.  
  407.     found_path = ''
  408.     for p in path:
  409.         try:
  410.             files = os.listdir(p)
  411.         except OSError:
  412.             continue
  413.         else:
  414.             if command in files:
  415.                 found_path = p
  416.                 break
  417.  
  418.     if return_full_path:
  419.         if found_path:
  420.             return os.path.join(found_path, command)
  421.         else:
  422.             return ''
  423.     else:
  424.         return found_path
  425.  
  426.  
  427. class UserSettings(object): # Note: Deprecated after 2.8.8 in Qt4 (see ui4/ui_utils.py)
  428.     def __init__(self):
  429.         self.load()
  430.  
  431.     def loadDefaults(self):
  432.         # Print
  433.         self.cmd_print = ''
  434.         path = which('hp-print')
  435.  
  436.         if len(path) > 0:
  437.             self.cmd_print = 'hp-print -p%PRINTER%'
  438.         else:
  439.             path = which('kprinter')
  440.             if len(path) > 0:
  441.                 self.cmd_print = 'kprinter -P%PRINTER% --system cups'
  442.             else:
  443.                 path = which('gtklp')
  444.                 if len(path) > 0:
  445.                     self.cmd_print = 'gtklp -P%PRINTER%'
  446.                 else:
  447.                     path = which('xpp')
  448.                     if len(path) > 0:
  449.                         self.cmd_print = 'xpp -P%PRINTER%'
  450.  
  451.         # Scan
  452.         self.cmd_scan = ''
  453.         path = which('xsane')
  454.  
  455.         if len(path) > 0:
  456.             self.cmd_scan = 'xsane -V %SANE_URI%'
  457.         else:
  458.             path = which('kooka')
  459.             if len(path) > 0:
  460.                 self.cmd_scan = 'kooka'
  461.             else:
  462.                 path = which('xscanimage')
  463.                 if len(path) > 0:
  464.                     self.cmd_scan = 'xscanimage'
  465.  
  466.         # Photo Card
  467.         path = which('hp-unload')
  468.  
  469.         if len(path):
  470.             self.cmd_pcard = 'hp-unload -d %DEVICE_URI%'
  471.         else:
  472.             self.cmd_pcard = 'python %HOME%/unload.py -d %DEVICE_URI%'
  473.  
  474.         # Copy
  475.         path = which('hp-makecopies')
  476.  
  477.         if len(path):
  478.             self.cmd_copy = 'hp-makecopies -d %DEVICE_URI%'
  479.         else:
  480.             self.cmd_copy = 'python %HOME%/makecopies.py -d %DEVICE_URI%'
  481.  
  482.         # Fax
  483.         path = which('hp-sendfax')
  484.  
  485.         if len(path):
  486.             self.cmd_fax = 'hp-sendfax -d %FAX_URI%'
  487.         else:
  488.             self.cmd_fax = 'python %HOME%/sendfax.py -d %FAX_URI%'
  489.  
  490.         # Fax Address Book
  491.         path = which('hp-fab')
  492.  
  493.         if len(path):
  494.             self.cmd_fab = 'hp-fab'
  495.         else:
  496.             self.cmd_fab = 'python %HOME%/fab.py'
  497.  
  498.     def load(self):
  499.         self.loadDefaults()
  500.         log.debug("Loading user settings...")
  501.         self.auto_refresh = to_bool(user_conf.get('refresh', 'enable', '0'))
  502.  
  503.         try:
  504.             self.auto_refresh_rate = int(user_conf.get('refresh', 'rate', '30'))
  505.         except ValueError:
  506.             self.auto_refresh_rate = 30 # (secs)
  507.  
  508.         try:
  509.             self.auto_refresh_type = int(user_conf.get('refresh', 'type', '0'))
  510.         except ValueError:
  511.             self.auto_refresh_type = 0 # refresh 1 (1=refresh all)
  512.  
  513.         self.cmd_print = user_conf.get('commands', 'prnt', self.cmd_print)
  514.         self.cmd_scan = user_conf.get('commands', 'scan', self.cmd_scan)
  515.         self.cmd_pcard = user_conf.get('commands', 'pcard', self.cmd_pcard)
  516.         self.cmd_copy = user_conf.get('commands', 'cpy', self.cmd_copy)
  517.         self.cmd_fax = user_conf.get('commands', 'fax', self.cmd_fax)
  518.         self.cmd_fab = user_conf.get('commands', 'fab', self.cmd_fab)
  519.         self.debug()
  520.  
  521.     def debug(self):
  522.         log.debug("Print command: %s" % self.cmd_print)
  523.         log.debug("PCard command: %s" % self.cmd_pcard)
  524.         log.debug("Fax command: %s" % self.cmd_fax)
  525.         log.debug("FAB command: %s" % self.cmd_fab)
  526.         log.debug("Copy command: %s " % self.cmd_copy)
  527.         log.debug("Scan command: %s" % self.cmd_scan)
  528.         log.debug("Auto refresh: %s" % self.auto_refresh)
  529.         log.debug("Auto refresh rate: %s" % self.auto_refresh_rate)
  530.         log.debug("Auto refresh type: %s" % self.auto_refresh_type)
  531.  
  532.     def save(self):
  533.         log.debug("Saving user settings...")
  534.         user_conf.set('commands', 'prnt', self.cmd_print)
  535.         user_conf.set('commands', 'pcard', self.cmd_pcard)
  536.         user_conf.set('commands', 'fax', self.cmd_fax)
  537.         user_conf.set('commands', 'scan', self.cmd_scan)
  538.         user_conf.set('commands', 'cpy', self.cmd_copy)
  539.         user_conf.set('refresh', 'enable',self.auto_refresh)
  540.         user_conf.set('refresh', 'rate', self.auto_refresh_rate)
  541.         user_conf.set('refresh', 'type', self.auto_refresh_type)
  542.         self.debug()
  543.  
  544.  
  545.  
  546. def no_qt_message_gtk():
  547.     try:
  548.         import gtk
  549.         w = gtk.Window()
  550.         dialog = gtk.MessageDialog(w, gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT,
  551.                                    gtk.MESSAGE_WARNING, gtk.BUTTONS_OK,
  552.                                    "PyQt not installed. GUI not available. Please check that the PyQt package is installed. Exiting.")
  553.         dialog.run()
  554.         dialog.destroy()
  555.  
  556.     except ImportError:
  557.         log.error("PyQt not installed. GUI not available. Please check that the PyQt package is installed. Exiting.")
  558.  
  559.  
  560. def canEnterGUIMode(): # qt3
  561.     if not prop.gui_build:
  562.         log.warn("GUI mode disabled in build.")
  563.         return False
  564.  
  565.     elif not os.getenv('DISPLAY'):
  566.         log.warn("No display found.")
  567.         return False
  568.  
  569.     elif not checkPyQtImport():
  570.         log.warn("Qt/PyQt 3 initialization failed.")
  571.         return False
  572.  
  573.     return True
  574.  
  575.  
  576. def canEnterGUIMode4(): # qt4
  577.     if not prop.gui_build:
  578.         log.warn("GUI mode disabled in build.")
  579.         return False
  580.  
  581.     elif not os.getenv('DISPLAY'):
  582.         log.warn("No display found.")
  583.         return False
  584.  
  585.     elif not checkPyQtImport4():
  586.         log.warn("Qt/PyQt 4 initialization failed.")
  587.         return False
  588.  
  589.     return True
  590.  
  591.  
  592. def checkPyQtImport(): # qt3
  593.     # PyQt
  594.     try:
  595.         import qt
  596.     except ImportError:
  597.         if os.getenv('DISPLAY') and os.getenv('STARTED_FROM_MENU'):
  598.             no_qt_message_gtk()
  599.  
  600.         log.error("PyQt not installed. GUI not available. Exiting.")
  601.         return False
  602.  
  603.     # check version of Qt
  604.     qtMajor = int(qt.qVersion().split('.')[0])
  605.  
  606.     if qtMajor < MINIMUM_QT_MAJOR_VER:
  607.  
  608.         log.error("Incorrect version of Qt installed. Ver. 3.0.0 or greater required.")
  609.         return False
  610.  
  611.     #check version of PyQt
  612.     try:
  613.         pyqtVersion = qt.PYQT_VERSION_STR
  614.     except AttributeError:
  615.         pyqtVersion = qt.PYQT_VERSION
  616.  
  617.     while pyqtVersion.count('.') < 2:
  618.         pyqtVersion += '.0'
  619.  
  620.     (maj_ver, min_ver, pat_ver) = pyqtVersion.split('.')
  621.  
  622.     if pyqtVersion.find('snapshot') >= 0:
  623.         log.warning("A non-stable snapshot version of PyQt is installed.")
  624.     else:
  625.         try:
  626.             maj_ver = int(maj_ver)
  627.             min_ver = int(min_ver)
  628.             pat_ver = int(pat_ver)
  629.         except ValueError:
  630.             maj_ver, min_ver, pat_ver = 0, 0, 0
  631.  
  632.         if maj_ver < MINIMUM_PYQT_MAJOR_VER or \
  633.             (maj_ver == MINIMUM_PYQT_MAJOR_VER and min_ver < MINIMUM_PYQT_MINOR_VER):
  634.             log.error("This program may not function properly with the version of PyQt that is installed (%d.%d.%d)." % (maj_ver, min_ver, pat_ver))
  635.             log.error("Incorrect version of pyQt installed. Ver. %d.%d or greater required." % (MINIMUM_PYQT_MAJOR_VER, MINIMUM_PYQT_MINOR_VER))
  636.             log.error("This program will continue, but you may experience errors, crashes or other problems.")
  637.             return True
  638.  
  639.     return True
  640.  
  641.  
  642. def checkPyQtImport4():
  643.     try:
  644.         import PyQt4
  645.     except ImportError:
  646.         return False
  647.     else:
  648.         return True
  649.  
  650.  
  651. try:
  652.     from string import Template # will fail in Python <= 2.3
  653. except ImportError:
  654.     # Code from Python 2.4 string.py
  655.     #import re as _re
  656.  
  657.     class _multimap:
  658.         """Helper class for combining multiple mappings.
  659.  
  660.         Used by .{safe_,}substitute() to combine the mapping and keyword
  661.         arguments.
  662.         """
  663.         def __init__(self, primary, secondary):
  664.             self._primary = primary
  665.             self._secondary = secondary
  666.  
  667.         def __getitem__(self, key):
  668.             try:
  669.                 return self._primary[key]
  670.             except KeyError:
  671.                 return self._secondary[key]
  672.  
  673.  
  674.     class _TemplateMetaclass(type):
  675.         pattern = r"""
  676.         %(delim)s(?:
  677.           (?P<escaped>%(delim)s) |   # Escape sequence of two delimiters
  678.           (?P<named>%(id)s)      |   # delimiter and a Python identifier
  679.           {(?P<braced>%(id)s)}   |   # delimiter and a braced identifier
  680.           (?P<invalid>)              # Other ill-formed delimiter exprs
  681.         )
  682.         """
  683.  
  684.         def __init__(cls, name, bases, dct):
  685.             super(_TemplateMetaclass, cls).__init__(name, bases, dct)
  686.             if 'pattern' in dct:
  687.                 pattern = cls.pattern
  688.             else:
  689.                 pattern = _TemplateMetaclass.pattern % {
  690.                     'delim' : re.escape(cls.delimiter),
  691.                     'id'    : cls.idpattern,
  692.                     }
  693.             cls.pattern = re.compile(pattern, re.IGNORECASE | re.VERBOSE)
  694.  
  695.  
  696.     class Template:
  697.         """A string class for supporting $-substitutions."""
  698.         __metaclass__ = _TemplateMetaclass
  699.  
  700.         delimiter = '$'
  701.         idpattern = r'[_a-z][_a-z0-9]*'
  702.  
  703.         def __init__(self, template):
  704.             self.template = template
  705.  
  706.         # Search for $$, $identifier, ${identifier}, and any bare $'s
  707.         def _invalid(self, mo):
  708.             i = mo.start('invalid')
  709.             lines = self.template[:i].splitlines(True)
  710.             if not lines:
  711.                 colno = 1
  712.                 lineno = 1
  713.             else:
  714.                 colno = i - len(''.join(lines[:-1]))
  715.                 lineno = len(lines)
  716.             raise ValueError('Invalid placeholder in string: line %d, col %d' %
  717.                              (lineno, colno))
  718.  
  719.         def substitute(self, *args, **kws):
  720.             if len(args) > 1:
  721.                 raise TypeError('Too many positional arguments')
  722.             if not args:
  723.                 mapping = kws
  724.             elif kws:
  725.                 mapping = _multimap(kws, args[0])
  726.             else:
  727.                 mapping = args[0]
  728.             # Helper function for .sub()
  729.             def convert(mo):
  730.                 # Check the most common path first.
  731.                 named = mo.group('named') or mo.group('braced')
  732.                 if named is not None:
  733.                     val = mapping[named]
  734.                     # We use this idiom instead of str() because the latter will
  735.                     # fail if val is a Unicode containing non-ASCII characters.
  736.                     return '%s' % val
  737.                 if mo.group('escaped') is not None:
  738.                     return self.delimiter
  739.                 if mo.group('invalid') is not None:
  740.                     self._invalid(mo)
  741.                 raise ValueError('Unrecognized named group in pattern',
  742.                                  self.pattern)
  743.             return self.pattern.sub(convert, self.template)
  744.  
  745.  
  746.         def safe_substitute(self, *args, **kws):
  747.             if len(args) > 1:
  748.                 raise TypeError('Too many positional arguments')
  749.             if not args:
  750.                 mapping = kws
  751.             elif kws:
  752.                 mapping = _multimap(kws, args[0])
  753.             else:
  754.                 mapping = args[0]
  755.             # Helper function for .sub()
  756.             def convert(mo):
  757.                 named = mo.group('named')
  758.                 if named is not None:
  759.                     try:
  760.                         # We use this idiom instead of str() because the latter
  761.                         # will fail if val is a Unicode containing non-ASCII
  762.                         return '%s' % mapping[named]
  763.                     except KeyError:
  764.                         return self.delimiter + named
  765.                 braced = mo.group('braced')
  766.                 if braced is not None:
  767.                     try:
  768.                         return '%s' % mapping[braced]
  769.                     except KeyError:
  770.                         return self.delimiter + '{' + braced + '}'
  771.                 if mo.group('escaped') is not None:
  772.                     return self.delimiter
  773.                 if mo.group('invalid') is not None:
  774.                     return self.delimiter
  775.                 raise ValueError('Unrecognized named group in pattern',
  776.                                  self.pattern)
  777.             return self.pattern.sub(convert, self.template)
  778.  
  779.  
  780.  
  781. #cat = lambda _ : Template(_).substitute(sys._getframe(1).f_globals, **sys._getframe(1).f_locals)
  782.  
  783. def cat(s):
  784.     globals = sys._getframe(1).f_globals.copy()
  785.     if 'self' in globals:
  786.         del globals['self']
  787.  
  788.     locals = sys._getframe(1).f_locals.copy()
  789.     if 'self' in locals:
  790.         del locals['self']
  791.  
  792.     return Template(s).substitute(sys._getframe(1).f_globals, **locals)
  793.  
  794.  
  795. identity = string.maketrans('','')
  796. unprintable = identity.translate(identity, string.printable)
  797.  
  798.  
  799. def printable(s):
  800.     return s.translate(identity, unprintable)
  801.  
  802.  
  803. def any(S,f=lambda x:x):
  804.     for x in S:
  805.         if f(x): return True
  806.     return False
  807.  
  808.  
  809. def all(S,f=lambda x:x):
  810.     for x in S:
  811.         if not f(x): return False
  812.     return True
  813.  
  814.  
  815. BROWSERS = ['firefox', 'mozilla', 'konqueror', 'galeon', 'skipstone'] # in preferred order
  816. BROWSER_OPTS = {'firefox': '-new-window', 'mozilla' : '', 'konqueror': '', 'galeon': '-w', 'skipstone': ''}
  817.  
  818.  
  819. def find_browser():
  820.     if platform_avail and platform.system() == 'Darwin':
  821.         return "open"
  822.     else:
  823.         for b in BROWSERS:
  824.             if which(b):
  825.                 return b
  826.         else:
  827.             return None
  828.  
  829.  
  830. def openURL(url, use_browser_opts=True):
  831.     if platform_avail and platform.system() == 'Darwin':
  832.         cmd = 'open "%s"' % url
  833.         log.debug(cmd)
  834.         os.system(cmd)
  835.     else:
  836.         for b in BROWSERS:
  837.             bb = which(b)
  838.             if bb:
  839.                 bb = os.path.join(bb, b)
  840.                 if use_browser_opts:
  841.                     cmd = """%s %s "%s" &""" % (bb, BROWSER_OPTS[b], url)
  842.                 else:
  843.                     cmd = """%s "%s" &""" % (bb, url)
  844.                 log.debug(cmd)
  845.                 os.system(cmd)
  846.                 break
  847.         else:
  848.             log.warn("Unable to open URL: %s" % url)
  849.  
  850.  
  851. def uniqueList(input):
  852.     temp = []
  853.     [temp.append(i) for i in input if not temp.count(i)]
  854.     return temp
  855.  
  856.  
  857. def list_move_up(l, m, cmp=None):
  858.     if cmp is None:
  859.         f = lambda x: l[x] == m
  860.     else:
  861.         f = lambda x: cmp(l[x], m)
  862.  
  863.     for i in range(1, len(l)):
  864.         if f(i):
  865.             l[i-1], l[i] = l[i], l[i-1]
  866.  
  867.  
  868. def list_move_down(l, m, cmp=None):
  869.     if cmp is None:
  870.         f = lambda x: l[x] == m
  871.     else:
  872.         f = lambda x: cmp(l[x], m)
  873.  
  874.     for i in range(len(l)-2, -1, -1):
  875.         if f(i):
  876.             l[i], l[i+1] = l[i+1], l[i]
  877.  
  878.  
  879.  
  880. class XMLToDictParser:
  881.     def __init__(self):
  882.         self.stack = []
  883.         self.data = {}
  884.         self.last_start = ''
  885.  
  886.     def startElement(self, name, attrs):
  887.         #print "START:", name, attrs
  888.         self.stack.append(unicode(name).lower())
  889.         self.last_start = unicode(name).lower()
  890.  
  891.         if len(attrs):
  892.             for a in attrs:
  893.                 self.stack.append(unicode(a).lower())
  894.                 self.addData(attrs[a])
  895.                 self.stack.pop()
  896.  
  897.     def endElement(self, name):
  898.         if name.lower() == self.last_start:
  899.             self.addData('')
  900.  
  901.         #print "END:", name
  902.         self.stack.pop()
  903.  
  904.     def charData(self, data):
  905.         data = unicode(data).strip()
  906.  
  907.         if data and self.stack:
  908.             self.addData(data)
  909.  
  910.     def addData(self, data):
  911.         #print "DATA:", data
  912.         self.last_start = ''
  913.         try:
  914.             data = int(data)
  915.         except ValueError:
  916.             data = unicode(data)
  917.  
  918.         stack_str = '-'.join(self.stack)
  919.         stack_str_0 = '-'.join([stack_str, '0'])
  920.  
  921.         try:
  922.             self.data[stack_str]
  923.         except KeyError:
  924.             try:
  925.                 self.data[stack_str_0]
  926.             except KeyError:
  927.                 self.data[stack_str] = data
  928.             else:
  929.                 j = 2
  930.                 while True:
  931.                     try:
  932.                         self.data['-'.join([stack_str, unicode(j)])]
  933.                     except KeyError:
  934.                         self.data['-'.join([stack_str, unicode(j)])] = data
  935.                         break
  936.                     j += 1
  937.  
  938.         else:
  939.             self.data[stack_str_0] = self.data[stack_str]
  940.             self.data['-'.join([stack_str, '1'])] = data
  941.             del self.data[stack_str]
  942.  
  943.  
  944.     def parseXML(self, text):
  945.         parser = expat.ParserCreate()
  946.         parser.StartElementHandler = self.startElement
  947.         parser.EndElementHandler = self.endElement
  948.         parser.CharacterDataHandler = self.charData
  949.         parser.Parse(text.encode('utf-8'), True)
  950.         return self.data
  951.  
  952.  
  953. def dquote(s):
  954.     return ''.join(['"', s, '"'])
  955.  
  956.  
  957. # Python 2.2.x compatibility functions (strip() family with char argument added in Python 2.2.3)
  958. if sys.hexversion < 0x020203f0:
  959.     def xlstrip(s, chars=' '):
  960.         i = 0
  961.         for c, i in zip(s, range(len(s))):
  962.             if c not in chars:
  963.                 break
  964.  
  965.         return s[i:]
  966.  
  967.     def xrstrip(s, chars=' '):
  968.         return xreverse(xlstrip(xreverse(s), chars))
  969.  
  970.     def xreverse(s):
  971.         l = list(s)
  972.         l.reverse()
  973.         return ''.join(l)
  974.  
  975.     def xstrip(s, chars=' '):
  976.         return xreverse(xlstrip(xreverse(xlstrip(s, chars)), chars))
  977.  
  978. else:
  979.     xlstrip = string.lstrip
  980.     xrstrip = string.rstrip
  981.     xstrip = string.strip
  982.  
  983.  
  984. def getBitness():
  985.     if platform_avail:
  986.         return int(platform.architecture()[0][:-3])
  987.     else:
  988.         return struct.calcsize("P") << 3
  989.  
  990.  
  991. def getProcessor():
  992.     if platform_avail:
  993.         return platform.machine().replace(' ', '_').lower() # i386, i686, power_macintosh, etc.
  994.     else:
  995.         return "i686" # TODO: Need a fix here
  996.  
  997.  
  998. def getEndian():
  999.     if sys.byteorder == 'big':
  1000.         return BIG_ENDIAN
  1001.     else:
  1002.         return LITTLE_ENDIAN
  1003.  
  1004.  
  1005. def get_password():
  1006.     return getpass.getpass("Enter password: ")
  1007.  
  1008.  
  1009. def run(cmd, log_output=True, password_func=get_password, timeout=1):
  1010.     output = cStringIO.StringIO()
  1011.  
  1012.     try:
  1013.         child = pexpect.spawn(cmd, timeout=timeout)
  1014.     except pexpect.ExceptionPexpect:
  1015.         return -1, ''
  1016.  
  1017.     try:
  1018.         while True:
  1019.             update_spinner()
  1020.             i = child.expect(["[pP]assword:", pexpect.EOF, pexpect.TIMEOUT])
  1021.  
  1022.             if child.before:
  1023.                 output.write(child.before)
  1024.                 if log_output:
  1025.                     log.debug(child.before)
  1026.  
  1027.             if i == 0: # Password:
  1028.                 if password_func is not None:
  1029.                     child.sendline(password_func())
  1030.                 else:
  1031.                     child.sendline(get_password())
  1032.  
  1033.             elif i == 1: # EOF
  1034.                 break
  1035.  
  1036.             elif i == 2: # TIMEOUT
  1037.                 continue
  1038.  
  1039.  
  1040.     except Exception, e:
  1041.         log.error("Exception: %s" % e)
  1042.  
  1043.     cleanup_spinner()
  1044.     child.close()
  1045.  
  1046.     return child.exitstatus, output.getvalue()
  1047.  
  1048.  
  1049. def expand_range(ns): # ns -> string repr. of numeric range, e.g. "1-4, 7, 9-12"
  1050.     """Credit: Jean Brouwers, comp.lang.python 16-7-2004
  1051.        Convert a string representation of a set of ranges into a
  1052.        list of ints, e.g.
  1053.        u"1-4, 7, 9-12" --> [1,2,3,4,7,9,10,11,12]
  1054.     """
  1055.     fs = []
  1056.     for n in ns.split(u','):
  1057.         n = n.strip()
  1058.         r = n.split('-')
  1059.         if len(r) == 2:  # expand name with range
  1060.             h = r[0].rstrip(u'0123456789')  # header
  1061.             r[0] = r[0][len(h):]
  1062.              # range can't be empty
  1063.             if not (r[0] and r[1]):
  1064.                 raise ValueError, 'empty range: ' + n
  1065.              # handle leading zeros
  1066.             if r[0] == u'0' or r[0][0] != u'0':
  1067.                 h += '%d'
  1068.             else:
  1069.                 w = [len(i) for i in r]
  1070.                 if w[1] > w[0]:
  1071.                    raise ValueError, 'wide range: ' + n
  1072.                 h += u'%%0%dd' % max(w)
  1073.              # check range
  1074.             r = [int(i, 10) for i in r]
  1075.             if r[0] > r[1]:
  1076.                raise ValueError, 'bad range: ' + n
  1077.             for i in range(r[0], r[1]+1):
  1078.                 fs.append(h % i)
  1079.         else:  # simple name
  1080.             fs.append(n)
  1081.  
  1082.      # remove duplicates
  1083.     fs = dict([(n, i) for i, n in enumerate(fs)]).keys()
  1084.      # convert to ints and sort
  1085.     fs = [int(x) for x in fs if x]
  1086.     fs.sort()
  1087.  
  1088.     return fs
  1089.  
  1090.  
  1091. def collapse_range(x): # x --> sorted list of ints
  1092.     """ Convert a list of integers into a string
  1093.         range representation:
  1094.         [1,2,3,4,7,9,10,11,12] --> u"1-4,7,9-12"
  1095.     """
  1096.     if not x:
  1097.         return ''
  1098.  
  1099.     s, c, r = [str(x[0])], x[0], False
  1100.  
  1101.     for i in x[1:]:
  1102.         if i == (c+1):
  1103.             r = True
  1104.         else:
  1105.             if r:
  1106.                 s.append(u'-%s,%s' % (c,i))
  1107.                 r = False
  1108.             else:
  1109.                 s.append(u',%s' % i)
  1110.  
  1111.         c = i
  1112.  
  1113.     if r:
  1114.         s.append(u'-%s' % i)
  1115.  
  1116.     return ''.join(s)
  1117.  
  1118.  
  1119. def createSequencedFilename(basename, ext, dir=None, digits=3):
  1120.     if dir is None:
  1121.         dir = os.getcwd()
  1122.  
  1123.     m = 0
  1124.     for f in walkFiles(dir, recurse=False, abs_paths=False, return_folders=False, pattern='*', path=None):
  1125.         r, e = os.path.splitext(f)
  1126.  
  1127.         if r.startswith(basename) and ext == e:
  1128.             try:
  1129.                 i = int(r[len(basename):])
  1130.             except ValueError:
  1131.                 continue
  1132.             else:
  1133.                 m = max(m, i)
  1134.  
  1135.     return os.path.join(dir, "%s%0*d%s" % (basename, digits, m+1, ext))
  1136.  
  1137.  
  1138. def validate_language(lang, default='en_US'):
  1139.     if lang is None:
  1140.         loc, encoder = locale.getdefaultlocale()
  1141.     else:
  1142.         lang = lang.lower().strip()
  1143.         for loc, ll in supported_locales.items():
  1144.             if lang in ll:
  1145.                 break
  1146.         else:
  1147.             loc = 'en_US'
  1148.             log.warn("Unknown lang/locale. Using default of %s." % loc)
  1149.  
  1150.     return loc
  1151.  
  1152.  
  1153. def gen_random_uuid():
  1154.     try:
  1155.         import uuid # requires Python 2.5+
  1156.         return str(uuid.uuid4())
  1157.  
  1158.     except ImportError:
  1159.         uuidgen = which("uuidgen")
  1160.         if uuidgen:
  1161.             uuidgen = os.path.join(uuidgen, "uuidgen")
  1162.             return commands.getoutput(uuidgen) # TODO: Replace with subprocess (commands is deprecated in Python 3.0)
  1163.         else:
  1164.             return ''
  1165.  
  1166.  
  1167. class RestTableFormatter(object):
  1168.     def __init__(self, header=None):
  1169.         self.header = header # tuple of strings
  1170.         self.rows = [] # list of tuples
  1171.  
  1172.     def add(self, row_data): # tuple of strings
  1173.         self.rows.append(row_data)
  1174.  
  1175.     def output(self, w):
  1176.         if self.rows:
  1177.             num_cols = len(self.rows[0])
  1178.             for r in self.rows:
  1179.                 if len(r) != num_cols:
  1180.                     log.error("Invalid number of items in row: %s" % r)
  1181.                     return
  1182.  
  1183.             if len(self.header) != num_cols:
  1184.                 log.error("Invalid number of items in header.")
  1185.  
  1186.             col_widths = []
  1187.             for x, c in enumerate(self.header):
  1188.                 max_width = len(c)
  1189.                 for r in self.rows:
  1190.                     max_width = max(max_width, len(r[x]))
  1191.  
  1192.                 col_widths.append(max_width+2)
  1193.  
  1194.             x = '+'
  1195.             for c in col_widths:
  1196.                 x = ''.join([x, '-' * (c+2), '+'])
  1197.  
  1198.             x = ''.join([x, '\n'])
  1199.             w.write(x)
  1200.  
  1201.             # header
  1202.             if self.header:
  1203.                 x = '|'
  1204.                 for i, c in enumerate(col_widths):
  1205.                     x = ''.join([x, ' ', self.header[i], ' ' * (c+1-len(self.header[i])), '|'])
  1206.  
  1207.                 x = ''.join([x, '\n'])
  1208.                 w.write(x)
  1209.  
  1210.                 x = '+'
  1211.                 for c in col_widths:
  1212.                     x = ''.join([x, '=' * (c+2), '+'])
  1213.  
  1214.                 x = ''.join([x, '\n'])
  1215.                 w.write(x)
  1216.  
  1217.             # data rows
  1218.             for j, r in enumerate(self.rows):
  1219.                 x = '|'
  1220.                 for i, c in enumerate(col_widths):
  1221.                     x = ''.join([x, ' ', self.rows[j][i], ' ' * (c+1-len(self.rows[j][i])), '|'])
  1222.  
  1223.                 x = ''.join([x, '\n'])
  1224.                 w.write(x)
  1225.  
  1226.                 x = '+'
  1227.                 for c in col_widths:
  1228.                     x = ''.join([x, '-' * (c+2), '+'])
  1229.  
  1230.                 x = ''.join([x, '\n'])
  1231.                 w.write(x)
  1232.  
  1233.         else:
  1234.             log.error("No data rows")
  1235.  
  1236.  
  1237. def mixin(cls):
  1238.     import inspect
  1239.  
  1240.     locals = inspect.stack()[1][0].f_locals
  1241.     if "__module__" not in locals:
  1242.         raise TypeError("Must call mixin() from within class def.")
  1243.  
  1244.     dict = cls.__dict__.copy()
  1245.     dict.pop("__doc__", None)
  1246.     dict.pop("__module__", None)
  1247.  
  1248.     locals.update(dict)
  1249.  
  1250.  
  1251.  
  1252. # TODO: Move usage stuff to to base/module/Module class
  1253.  
  1254.  
  1255.  # ------------------------- Usage Help
  1256. USAGE_OPTIONS = ("[OPTIONS]", "", "heading", False)
  1257. USAGE_LOGGING1 = ("Set the logging level:", "-l<level> or --logging=<level>", 'option', False)
  1258. USAGE_LOGGING2 = ("", "<level>: none, info\*, error, warn, debug (\*default)", "option", False)
  1259. USAGE_LOGGING3 = ("Run in debug mode:", "-g (same as option: -ldebug)", "option", False)
  1260. USAGE_LOGGING_PLAIN = ("Output plain text only:", "-t", "option", False)
  1261. USAGE_ARGS = ("[PRINTER|DEVICE-URI]", "", "heading", False)
  1262. USAGE_ARGS2 = ("[PRINTER]", "", "heading", False)
  1263. USAGE_DEVICE = ("To specify a device-URI:", "-d<device-uri> or --device=<device-uri>", "option", False)
  1264. USAGE_PRINTER = ("To specify a CUPS printer:", "-p<printer> or --printer=<printer>", "option", False)
  1265. USAGE_BUS1 = ("Bus to probe (if device not specified):", "-b<bus> or --bus=<bus>", "option", False)
  1266. USAGE_BUS2 = ("", "<bus>: cups\*, usb\*, net, bt, fw, par\* (\*defaults) (Note: bt and fw not supported in this release.)", 'option', False)
  1267. USAGE_HELP = ("This help information:", "-h or --help", "option", True)
  1268. USAGE_SPACE = ("", "", "space", False)
  1269. USAGE_EXAMPLES = ("Examples:", "", "heading", False)
  1270. USAGE_NOTES = ("Notes:", "", "heading", False)
  1271. USAGE_STD_NOTES1 = ("If device or printer is not specified, the local device bus is probed and the program enters interactive mode.", "", "note", False)
  1272. USAGE_STD_NOTES2 = ("If -p\* is specified, the default CUPS printer will be used.", "", "note", False)
  1273. USAGE_SEEALSO = ("See Also:", "", "heading", False)
  1274. USAGE_LANGUAGE = ("Set the language:", "-q <lang> or --lang=<lang>. Use -q? or --lang=? to see a list of available language codes.", "option", False)
  1275. USAGE_LANGUAGE2 = ("Set the language:", "--lang=<lang>. Use --lang=? to see a list of available language codes.", "option", False)
  1276. USAGE_MODE = ("[MODE]", "", "header", False)
  1277. USAGE_NON_INTERACTIVE_MODE = ("Run in non-interactive mode:", "-n or --non-interactive", "option", False)
  1278. USAGE_GUI_MODE = ("Run in graphical UI mode:", "-u or --gui (Default)", "option", False)
  1279. USAGE_INTERACTIVE_MODE = ("Run in interactive mode:", "-i or --interactive", "option", False)
  1280.  
  1281. if sys_conf.get('configure', 'ui-toolkit', 'qt3') == 'qt3':
  1282.     USAGE_USE_QT3 = ("Use Qt3:",  "--qt3 (Default)",  "option",  False)
  1283.     USAGE_USE_QT4 = ("Use Qt4:",  "--qt4",  "option",  False)
  1284. else:
  1285.     USAGE_USE_QT3 = ("Use Qt3:",  "--qt3",  "option",  False)
  1286.     USAGE_USE_QT4 = ("Use Qt4:",  "--qt4 (Default)",  "option",  False)
  1287.  
  1288.  
  1289.  
  1290.  
  1291. def ttysize(): # TODO: Move to base/tui
  1292.     ln1 = commands.getoutput('stty -a').splitlines()[0]
  1293.     vals = {'rows':None, 'columns':None}
  1294.     for ph in ln1.split(';'):
  1295.         x = ph.split()
  1296.         if len(x) == 2:
  1297.             vals[x[0]] = x[1]
  1298.             vals[x[1]] = x[0]
  1299.     try:
  1300.         rows, cols = int(vals['rows']), int(vals['columns'])
  1301.     except TypeError:
  1302.         rows, cols = 25, 80
  1303.  
  1304.     return rows, cols
  1305.  
  1306.  
  1307. def usage_formatter(override=0): # TODO: Move to base/module/Module class
  1308.     rows, cols = ttysize()
  1309.  
  1310.     if override:
  1311.         col1 = override
  1312.         col2 = cols - col1 - 8
  1313.     else:
  1314.         col1 = int(cols / 3) - 8
  1315.         col2 = cols - col1 - 8
  1316.  
  1317.     return TextFormatter(({'width': col1, 'margin' : 2},
  1318.                             {'width': col2, 'margin' : 2},))
  1319.  
  1320.  
  1321. def format_text(text_list, typ='text', title='', crumb='', version=''): # TODO: Move to base/module/Module class
  1322.     """
  1323.     Format usage text in multiple formats:
  1324.         text: for --help in the console
  1325.         rest: for conversion with rst2web for the website
  1326.         man: for manpages
  1327.     """
  1328.     if typ == 'text':
  1329.         formatter = usage_formatter()
  1330.  
  1331.         for line in text_list:
  1332.             text1, text2, format, trailing_space = line
  1333.  
  1334.             # remove any reST/man escapes
  1335.             text1 = text1.replace("\\", "")
  1336.             text2 = text2.replace("\\", "")
  1337.  
  1338.             if format == 'summary':
  1339.                 log.info(log.bold(text1))
  1340.                 log.info("")
  1341.  
  1342.             elif format in ('para', 'name', 'seealso'):
  1343.                 log.info(text1)
  1344.  
  1345.                 if trailing_space:
  1346.                     log.info("")
  1347.  
  1348.             elif format in ('heading', 'header'):
  1349.                 log.info(log.bold(text1))
  1350.  
  1351.             elif format in ('option', 'example'):
  1352.                 log.info(formatter.compose((text1, text2), trailing_space))
  1353.  
  1354.             elif format == 'note':
  1355.                 if text1.startswith(' '):
  1356.                     log.info('\t' + text1.lstrip())
  1357.                 else:
  1358.                     log.info(text1)
  1359.  
  1360.             elif format == 'space':
  1361.                 log.info("")
  1362.  
  1363.         log.info("")
  1364.  
  1365.  
  1366.     elif typ == 'rest':
  1367.         opt_colwidth1, opt_colwidth2 = 0, 0
  1368.         exmpl_colwidth1, exmpl_colwidth2 = 0, 0
  1369.         note_colwidth1, note_colwidth2 = 0, 0
  1370.  
  1371.         for line in text_list:
  1372.             text1, text2, format, trailing_space = line
  1373.  
  1374.             if format  == 'option':
  1375.                 opt_colwidth1 = max(len(text1), opt_colwidth1)
  1376.                 opt_colwidth2 = max(len(text2), opt_colwidth2)
  1377.  
  1378.             elif format == 'example':
  1379.                 exmpl_colwidth1 = max(len(text1), exmpl_colwidth1)
  1380.                 exmpl_colwidth2 = max(len(text2), exmpl_colwidth2)
  1381.  
  1382.             elif format == 'note':
  1383.                 note_colwidth1 = max(len(text1), note_colwidth1)
  1384.                 note_colwidth2 = max(len(text2), note_colwidth2)
  1385.  
  1386.         opt_colwidth1 += 4
  1387.         opt_colwidth2 += 4
  1388.         exmpl_colwidth1 += 4
  1389.         exmpl_colwidth2 += 4
  1390.         note_colwidth1 += 4
  1391.         note_colwidth2 += 4
  1392.         opt_tablewidth = opt_colwidth1 + opt_colwidth2
  1393.         exmpl_tablewidth = exmpl_colwidth1 + exmpl_colwidth2
  1394.         note_tablewidth = note_colwidth1 + note_colwidth2
  1395.  
  1396.         # write the rst2web header
  1397.         log.info("""restindex
  1398. page-title: %s
  1399. crumb: %s
  1400. format: rest
  1401. file-extension: html
  1402. encoding: utf8
  1403. /restindex\n""" % (title, crumb))
  1404.  
  1405.         t = "%s: %s (ver. %s)" % (crumb, title, version)
  1406.         log.info(t)
  1407.         log.info("="*len(t))
  1408.         log.info("")
  1409.  
  1410.         links = []
  1411.         needs_header = False
  1412.         for line in text_list:
  1413.             text1, text2, format, trailing_space = line
  1414.  
  1415.             if format == 'seealso':
  1416.                 links.append(text1)
  1417.                 text1 = "`%s`_" % text1
  1418.  
  1419.             len1, len2 = len(text1), len(text2)
  1420.  
  1421.             if format == 'summary':
  1422.                 log.info(''.join(["**", text1, "**"]))
  1423.                 log.info("")
  1424.  
  1425.             elif format in ('para', 'name'):
  1426.                 log.info("")
  1427.                 log.info(text1)
  1428.                 log.info("")
  1429.  
  1430.             elif format in ('heading', 'header'):
  1431.  
  1432.                 log.info("")
  1433.                 log.info("**" + text1 + "**")
  1434.                 log.info("")
  1435.                 needs_header = True
  1436.  
  1437.             elif format == 'option':
  1438.                 if needs_header:
  1439.                     log.info(".. class:: borderless")
  1440.                     log.info("")
  1441.                     log.info(''.join(["+", "-"*opt_colwidth1, "+", "-"*opt_colwidth2, "+"]))
  1442.                     needs_header = False
  1443.  
  1444.                 if text1 and '`_' not in text1:
  1445.                     log.info(''.join(["| *", text1, '*', " "*(opt_colwidth1-len1-3), "|", text2, " "*(opt_colwidth2-len2), "|"]))
  1446.                 elif text1:
  1447.                     log.info(''.join(["|", text1, " "*(opt_colwidth1-len1), "|", text2, " "*(opt_colwidth2-len2), "|"]))
  1448.                 else:
  1449.                     log.info(''.join(["|", " "*(opt_colwidth1), "|", text2, " "*(opt_colwidth2-len2), "|"]))
  1450.  
  1451.                 log.info(''.join(["+", "-"*opt_colwidth1, "+", "-"*opt_colwidth2, "+"]))
  1452.  
  1453.             elif format == 'example':
  1454.                 if needs_header:
  1455.                     log.info(".. class:: borderless")
  1456.                     log.info("")
  1457.                     log.info(''.join(["+", "-"*exmpl_colwidth1, "+", "-"*exmpl_colwidth2, "+"]))
  1458.                     needs_header = False
  1459.  
  1460.                 if text1 and '`_' not in text1:
  1461.                     log.info(''.join(["| *", text1, '*', " "*(exmpl_colwidth1-len1-3), "|", text2, " "*(exmpl_colwidth2-len2), "|"]))
  1462.                 elif text1:
  1463.                     log.info(''.join(["|", text1, " "*(exmpl_colwidth1-len1), "|", text2, " "*(exmpl_colwidth2-len2), "|"]))
  1464.                 else:
  1465.                     log.info(''.join(["|", " "*(exmpl_colwidth1), "|", text2, " "*(exmpl_colwidth2-len2), "|"]))
  1466.  
  1467.                 log.info(''.join(["+", "-"*exmpl_colwidth1, "+", "-"*exmpl_colwidth2, "+"]))
  1468.  
  1469.             elif format == 'seealso':
  1470.                 if text1 and '`_' not in text1:
  1471.                     log.info(text1)
  1472.  
  1473.  
  1474.             elif format == 'note':
  1475.                 if needs_header:
  1476.                     log.info(".. class:: borderless")
  1477.                     log.info("")
  1478.                     log.info(''.join(["+", "-"*note_colwidth1, "+", "-"*note_colwidth2, "+"]))
  1479.                     needs_header = False
  1480.  
  1481.                 if text1.startswith(' '):
  1482.                     log.info(''.join(["|", " "*(note_tablewidth+1), "|"]))
  1483.  
  1484.                 log.info(''.join(["|", text1, " "*(note_tablewidth-len1+1), "|"]))
  1485.                 log.info(''.join(["+", "-"*note_colwidth1, "+", "-"*note_colwidth2, "+"]))
  1486.  
  1487.             elif format == 'space':
  1488.                 log.info("")
  1489.  
  1490.         for l in links:
  1491.             log.info("\n.. _`%s`: %s.html\n" % (l, l.replace('hp-', '')))
  1492.  
  1493.         log.info("")
  1494.  
  1495.     elif typ == 'man':
  1496.         log.info('.TH "%s" 1 "%s" Linux "User Manuals"' % (crumb, version))
  1497.         log.info(".SH NAME\n%s \- %s" % (crumb, title))
  1498.  
  1499.         for line in text_list:
  1500.             text1, text2, format, trailing_space = line
  1501.  
  1502.             text1 = text1.replace("\\*", "*")
  1503.             text2 = text2.replace("\\*", "*")
  1504.  
  1505.             len1, len2 = len(text1), len(text2)
  1506.  
  1507.             if format == 'summary':
  1508.                 log.info(".SH SYNOPSIS")
  1509.                 log.info(".B %s" % text1.replace('Usage:', ''))
  1510.  
  1511.             elif format == 'name':
  1512.                 log.info(".SH DESCRIPTION\n%s" % text1)
  1513.  
  1514.             elif format in ('option', 'example', 'note'):
  1515.                 if text1:
  1516.                     log.info('.IP "%s"\n%s' % (text1, text2))
  1517.                 else:
  1518.                     log.info(text2)
  1519.  
  1520.             elif format in ('header', 'heading'):
  1521.                 log.info(".SH %s" % text1.upper().replace(':', '').replace('[', '').replace(']', ''))
  1522.  
  1523.             elif format in ('seealso, para'):
  1524.                 log.info(text1)
  1525.  
  1526.         log.info(".SH AUTHOR")
  1527.         log.info("HPLIP (Hewlett-Packard Linux Imaging and Printing) is an")
  1528.         log.info("HP developed solution for printing, scanning, and faxing with")
  1529.         log.info("HP inkjet and laser based printers in Linux.")
  1530.  
  1531.         log.info(".SH REPORTING BUGS")
  1532.         log.info("The HPLIP Launchpad.net site")
  1533.         log.info(".B https://launchpad.net/hplip")
  1534.         log.info("is available to get help, report")
  1535.         log.info("bugs, make suggestions, discuss the HPLIP project or otherwise")
  1536.         log.info("contact the HPLIP Team.")
  1537.  
  1538.         log.info(".SH COPYRIGHT")
  1539.         log.info("Copyright (c) 2001-9 Hewlett-Packard Development Company, L.P.")
  1540.         log.info(".LP")
  1541.         log.info("This software comes with ABSOLUTELY NO WARRANTY.")
  1542.         log.info("This is free software, and you are welcome to distribute it")
  1543.         log.info("under certain conditions. See COPYING file for more details.")
  1544.  
  1545.         log.info("")
  1546.  
  1547.  
  1548. def log_title(program_name, version, show_ver=True): # TODO: Move to base/module/Module class
  1549.     log.info("")
  1550.  
  1551.     if show_ver:
  1552.         log.info(log.bold("HP Linux Imaging and Printing System (ver. %s)" % prop.version))
  1553.     else:
  1554.         log.info(log.bold("HP Linux Imaging and Printing System"))
  1555.  
  1556.     log.info(log.bold("%s ver. %s" % (program_name, version)))
  1557.     log.info("")
  1558.     log.info("Copyright (c) 2001-9 Hewlett-Packard Development Company, LP")
  1559.     log.info("This software comes with ABSOLUTELY NO WARRANTY.")
  1560.     log.info("This is free software, and you are welcome to distribute it")
  1561.     log.info("under certain conditions. See COPYING file for more details.")
  1562.     log.info("")
  1563.  
  1564.  
  1565. def ireplace(old, search, replace):
  1566.     regex = '(?i)' + re.escape(search)
  1567.     return re.sub(regex, replace, old)
  1568.  
  1569.  
  1570. def su_sudo():
  1571.     su_sudo_str = None
  1572.  
  1573.     if which('kdesu'):
  1574.         su_sudo_str = 'kdesu -- %s'
  1575.  
  1576.     elif utils.which('/usr/lib/kde4/libexec/kdesu'):
  1577.         su_sudo_str = '/usr/lib/kde4/libexec/kdesu -- %s'
  1578.  
  1579.     elif utils.which('kdesudo'):
  1580.         su_sudo_str = 'kdesudo -- %s'
  1581.  
  1582.     elif which('gnomesu'):
  1583.         su_sudo_str = 'gnomesu -c "%s"'
  1584.  
  1585.     elif which('gksu'):
  1586.         su_sudo_str = 'gksu "%s"'
  1587.  
  1588.     return su_sudo_str
  1589.  
  1590.  
  1591. #
  1592. # Removes HTML or XML character references and entities from a text string.
  1593. #
  1594.  
  1595. def unescape(text):
  1596.     def fixup(m):
  1597.         text = m.group(0)
  1598.         if text[:2] == "&#":
  1599.             # character reference
  1600.             try:
  1601.                 if text[:3] == "&#x":
  1602.                     #return unichr(int(text[3:-1], 16))
  1603.                     return chr(int(text[3:-1], 16))
  1604.                 else:
  1605.                     #return unichr(int(text[2:-1]))
  1606.                     return chr(int(text[2:-1]))
  1607.             except ValueError:
  1608.                 pass
  1609.         else:
  1610.             # named entity
  1611.             try:
  1612.                 #text = unichr(htmlentitydefs.name2codepoint[text[1:-1]])
  1613.                 text = chr(htmlentitydefs.name2codepoint[text[1:-1]])
  1614.             except KeyError:
  1615.                 pass
  1616.         return text # leave as is
  1617.     return re.sub("&#?\w+;", fixup, text)
  1618.  
  1619.  
  1620. # Adds HTML or XML character references and entities from a text string
  1621.  
  1622. def escape(s):
  1623.     if not isinstance(s, unicode):
  1624.         s = unicode(s) # hmmm...
  1625.  
  1626.     s = s.replace(u"&", u"&")
  1627.  
  1628.     for c in htmlentitydefs.codepoint2name:
  1629.         if c != 0x26: # exclude &
  1630.             s = s.replace(unichr(c), u"&%s;" % htmlentitydefs.codepoint2name[c])
  1631.  
  1632.     for c in range(0x20) + range(0x7f, 0xa0):
  1633.         s = s.replace(unichr(c), u"&#%d;" % c)
  1634.  
  1635.     return s
  1636.